Skip to content

Feat/terraform docs #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Nov 11, 2024
Merged

Feat/terraform docs #11

merged 12 commits into from
Nov 11, 2024

Conversation

Artlvns
Copy link
Contributor

@Artlvns Artlvns commented Nov 1, 2024

feat: terraform doc gen action based on terraform docs, with pinned hard version. Action does following steps:

  • Checks if README.md exists.
  • If it does - action validate if delimiters are added and placed correctly ( BEGIN should go before END).
  • If delimiters found but placed in wrong order action will fail.
  • If no delimiters found in existing README - they will be added at the end of file with info comment.
  • If no README.md found - doc action will generate new one and commit to PR.

Action runs on Github own runner so we don't need run 3rd part pinned version on own hosted runners ( Kind of security measure )

@Artlvns Artlvns requested a review from Laffs2k5 November 1, 2024 13:52
@Artlvns
Copy link
Contributor Author

Artlvns commented Nov 1, 2024

Copy link
Contributor

@Laffs2k5 Laffs2k5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks awesome!

What happens when a commit is pushed? A new PR workflow is scheduled and ran?

@Artlvns
Copy link
Contributor Author

Artlvns commented Nov 1, 2024

Looks awesome!

What happens when a commit is pushed? A new PR workflow is scheduled and ran?

Yes. When branch is updated so everything runs again. Tests are done and we make sure that they are green. If everything is OK there, then we run terraform docs again and see if there are any changes to README.md that need to be pushed.

@Artlvns Artlvns merged commit 7ed4efa into main Nov 11, 2024
@Artlvns Artlvns deleted the feat/terraform-docs branch November 11, 2024 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants